Skip to content

/v2/blueprints/{blueprint_id}/
Stable

Request

Retrieves the full configuration for a single blueprint by its ID.

Returns the BlueprintV2 object representing the blueprint's current configuration and metadata. This does not return version-specific settings on its own; use the versions endpoints to retrieve a specific published version's configuration.

About Get Blueprint

Blueprints define device configuration and management rules, including kiosk and device mode settings, app and file payloads, Wi-Fi networks, and OS-specific restrictions. This endpoint returns the blueprint record itself; the actual configuration a device receives comes from a specific version of the blueprint, retrieved separately through the versions endpoints. Blueprint V2 is the current version of this system and should be used for all new integrations; Blueprint V1 (the older devicegroup-scoped blueprint endpoints) is deprecated.

Common Use Cases

Looking up a blueprint's current metadata before publishing a new version

Confirming a blueprint exists and is accessible before assigning it to a device or group through Converge

Best Practices

Use the returned id together with the versions endpoints to retrieve the specific configuration a device will receive

Treat a 404 response as meaning the blueprint_id does not exist or was deleted, not as a transient error

Workflow

Obtain the blueprint_id from a blueprint list or from POST /v2/blueprints/

Call this endpoint to retrieve the blueprint record

Call GET /v2/blueprints/{blueprint_id}/versions/ to see its published versions

Path
blueprint_idstring, (uuid)required
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v2/blueprints/{blueprint_id}/'

Responses

Success

Bodyapplication/json
contentobject(blueprints_BlueprintV2)
messagestring
codeinteger
Value:201
Response
{
  "content": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "comments": "string",
    "version_number": 0,
    "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
    "minor_version_number": 0,
    "publish": true,
    "settings": { … },
    "created_by": "string",
    "updated_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "code": 201
}